<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.8.0" />

	<title>Class Indexer</title>

	<script type="text/javascript" src="resources/combined.js?174271566"></script>
	<script type="text/javascript" src="elementlist.js?2473211788"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
		</div>



		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li class="active"><a href="class-Indexer.html">Indexer</a></li>
				<li><a href="class-SBWord.html">SBWord</a></li>
				<li><a href="class-SpiderBot.html">SpiderBot</a></li>
			</ul>





		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class Indexer</h1>


	<div class="description">
	
<p>This is the "base controller class". All other "real" controllers extend this
class.</p>

	</div>









	<div class="info">
		
		
		
		

		<b>Located at</b> <a href="source-class-Indexer.html#11-105" title="Go to source code">Indexer.php</a><br />
	</div>



	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="processDocument" id="_processDocument">

		<td class="attributes"><code>
			 public 
			Integer
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_processDocument">#</a>
		<code><a href="source-class-Indexer.html#19-40" title="Go to source code">processDocument</a>( <span>String <var>$documentData</var></span>, <span>mixed <var>$url</var></span> )</code>

		<div class="description short">
			
<p>Searches for all the words from our Dictionary in this Document</p>

		</div>

		<div class="description detailed hidden">
			
<p>Searches for all the words from our Dictionary in this Document</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$documentData</var></dt>
					<dd><code>String</code><br>$documentData</dd>
					<dt><var>$url</var></dt>
					<dd></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>Integer</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="findWord" id="_findWord">

		<td class="attributes"><code>
			 public 
			Integer
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_findWord">#</a>
		<code><a href="source-class-Indexer.html#42-54" title="Go to source code">findWord</a>( <span>String <var>$documentData</var></span>, <span>String <var>$word</var></span> )</code>

		<div class="description short">
			
<p>Searches for a given word in the Document Data</p>

		</div>

		<div class="description detailed hidden">
			
<p>Searches for a given word in the Document Data</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$documentData</var></dt>
					<dd><code>String</code><br>$documentData Text data of the HTML Document</dd>
					<dt><var>$word</var></dt>
					<dd><code>String</code><br>$word Word to be searched for</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>Integer</code><br>The position where the word was found<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="openDBConnection" id="_openDBConnection">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_openDBConnection">#</a>
		<code><a href="source-class-Indexer.html#56-62" title="Go to source code">openDBConnection</a>( )</code>

		<div class="description short">
			
<p>Opens up a Database connection and sets the $connection variable to hold this
connection</p>

		</div>

		<div class="description detailed hidden">
			
<p>Opens up a Database connection and sets the $connection variable to hold this
connection</p>








		</div>
		</div></td>
	</tr>
	<tr data-order="closeDBConnection" id="_closeDBConnection">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_closeDBConnection">#</a>
		<code><a href="source-class-Indexer.html#64-69" title="Go to source code">closeDBConnection</a>( )</code>

		<div class="description short">
			
<p>Closes an Open database connection</p>

		</div>

		<div class="description detailed hidden">
			
<p>Closes an Open database connection</p>








		</div>
		</div></td>
	</tr>
	<tr data-order="indexData" id="_indexData">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_indexData">#</a>
		<code><a href="source-class-Indexer.html#71-79" title="Go to source code">indexData</a>( <span>String <var>$URL</var></span>, <span>String <var>$Word</var></span>, <span>type <var>$Position</var></span> )</code>

		<div class="description short">
			
<p>Time to index this data into the Database</p>

		</div>

		<div class="description detailed hidden">
			
<p>Time to index this data into the Database</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$URL</var></dt>
					<dd><code>String</code><br>$URL Address of the link where</dd>
					<dt><var>$Word</var></dt>
					<dd><code>String</code><br>$Word Word to index this document against</dd>
					<dt><var>$Position</var></dt>
					<dd><code>type</code><br>$Position Position of the word in this Document</dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="fillDictionary" id="_fillDictionary">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_fillDictionary">#</a>
		<code><a href="source-class-Indexer.html#81-99" title="Go to source code">fillDictionary</a>( )</code>

		<div class="description short">
			
<p>Fill our Dictionary of Words from the Database</p>

		</div>

		<div class="description detailed hidden">
			
<p>Fill our Dictionary of Words from the Database</p>








		</div>
		</div></td>
	</tr>
	<tr data-order="__construct" id="___construct">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#___construct">#</a>
		<code><a href="source-class-Indexer.html#101-103" title="Go to source code">__construct</a>( )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			







		</div>
		</div></td>
	</tr>
	</table>












	<table class="summary" id="properties">
	<caption>Properties summary</caption>
	<tr data-order="connection" id="$connection">
		<td class="attributes"><code>
			protected  
			mixed
		</code></td>

		<td class="name">
				<a href="source-class-Indexer.html#16" title="Go to source code"><var>$connection</var></a>
		</td>
		<td class="value"><code></code></td>
		<td class="description"><div>
			<a href="#$connection" class="anchor">#</a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</div></td>
	</tr>
	<tr data-order="Dictionary" id="$Dictionary">
		<td class="attributes"><code>
			protected  
			array
		</code></td>

		<td class="name">
				<a href="source-class-Indexer.html#17" title="Go to source code"><var>$Dictionary</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">array</span>()</code></td>
		<td class="description"><div>
			<a href="#$Dictionary" class="anchor">#</a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</div></td>
	</tr>
	</table>






</div>

	<div id="footer">
		 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
	</div>
</div>
</div>
</body>
</html>
